/*******************************************************************************
 * Copyright (c) 2014, 2014 IBM Corp. and others
 *
 * This program and the accompanying materials are made available under
 * the terms of the Eclipse Public License 2.0 which accompanies this
 * distribution and is available at https://www.eclipse.org/legal/epl-2.0/
 * or the Apache License, Version 2.0 which accompanies this distribution and
 * is available at https://www.apache.org/licenses/LICENSE-2.0.
 *
 * This Source Code may also be made available under the following
 * Secondary Licenses when the conditions for such availability set
 * forth in the Eclipse Public License, v. 2.0 are satisfied: GNU
 * General Public License, version 2 with the GNU Classpath
 * Exception [1] and GNU General Public License, version 2 with the
 * OpenJDK Assembly Exception [2].
 *
 * [1] https://www.gnu.org/software/classpath/license.html
 * [2] http://openjdk.java.net/legal/assembly-exception.html
 *
 * SPDX-License-Identifier: EPL-2.0 OR Apache-2.0 OR GPL-2.0 WITH Classpath-exception-2.0 OR LicenseRef-GPL-2.0 WITH Assembly-exception
 *******************************************************************************/
package com.ibm.j9ddr.vm29.tools.ddrinteractive.commands;

import java.io.PrintStream;

import com.ibm.j9ddr.CorruptDataException;
import com.ibm.j9ddr.tools.ddrinteractive.Command;
import com.ibm.j9ddr.tools.ddrinteractive.Context;
import com.ibm.j9ddr.tools.ddrinteractive.DDRInteractiveCommandException;
import com.ibm.j9ddr.vm29.structure.J9MemorySegment;
import com.ibm.j9ddr.vm29.j9.DataType;
import com.ibm.j9ddr.vm29.j9.walkers.MemorySegmentIterator;
import com.ibm.j9ddr.vm29.pointer.generated.J9JavaVMPointer;
import com.ibm.j9ddr.vm29.pointer.helper.J9RASHelper;

public class FindOverlappingSegmentsCommand extends Command {
	private static final String nl = System.getProperty("line.separator");

	private static void printHelp(PrintStream out) {
		out.append("!findoverlappingsegments         -- Search for overlaps between all J9MemorySegments except the SHARED_META segment.");
		out.append(nl);
		out.append("!findoverlappingsegments all     -- Search for overlaps between all J9MemorySegments.");
		out.append(nl);
		out.append("!findoverlappingsegments virtual -- Search for overlaps between virtual J9MemorySegments.");
		out.append(nl);
		out.append("!findoverlappingsegments help    -- Print this help message.");
		out.append(nl);
	}

	public FindOverlappingSegmentsCommand() {
		addCommand("findoverlappingsegments", "[all|virtual|help]", "find overlapping J9MemorySegments");
	}

	public void run(String command, String[] args, Context context, PrintStream out)
			throws DDRInteractiveCommandException
	{
		int segmentType = MemorySegmentIterator.MEMORY_ALL_TYPES & ~((int)J9MemorySegment.MEMORY_TYPE_SHARED_META);

		if (args.length == 0) {
			/* use default */
		} else {
			String argument = args[0];
			if (argument.equalsIgnoreCase("help")) {
				printHelp(out);
				return;
			} else if (argument.equalsIgnoreCase("all")) {
				segmentType = MemorySegmentIterator.MEMORY_ALL_TYPES;
			} else if (argument.equalsIgnoreCase("virtual")) {
				segmentType = (int)J9MemorySegment.MEMORY_TYPE_VIRTUAL;
			}
		}

		try {
			J9JavaVMPointer vm = J9RASHelper.getVM(DataType.getJ9RASPointer());
			SegmentsUtil.checkSegmentsForOverlap(out, vm, segmentType);
			out.append(nl);
		} catch (CorruptDataException e) {
			throw new DDRInteractiveCommandException(e);
		}
	}
}
